ATSUClearFontFeatures

OSStatus ATSUClearFontFeatures (
                     ATSUStyle iStyle,
                     ItemCount iFeatureCount,
                     ATSUFontFeatureType iType[],
                     ATSUFontFeatureSelector iSelector[]);

iStyle

A reference of type ATSUStyle. Pass a reference to a valid style object whose font features you want to remove. You cannot pass NULL for this parameter.

iFeatureCount

The number of font features you want to remove. To remove all previously set font features, pass the constant kATSUClearAll in this parameter. In this case, the values in the iType and iSelector parameters will be ignored.

iType

An array of values of type ATSUFontFeatureType. Each element in the array must contain a valid feature type that identifies a font feature you want to remove.

iSelector

An array of values of type ATSUFontFeatureSelector. Each element in the array must contain a valid feature selector that specifies the setting for the font feature that you want to remove.

function result

A result code. See Result Codes. You can remove unset font feature values from a style object without a function error.

DISCUSSION

The ATSUClearFontFeatures function removes those previously set font features that are identified by the feature selector and type constants in the iSelector and iType arrays. It replaces them with their font-defined default values.

If you wish to remove all previously set font features from a style object, pass kATSUClearAll in the iFeatureCount parameter. To remove all previously set style run attribute, font feature, and font variation values from a style object, call the function ATSUClearStyle. To remove just the previously set font variation values from a style object, call the function ATSUClearFontVariations.

VERSION NOTES

Available beginning with ATSUI 1.0.